home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / diag / lv104.zip / LV.DOC next >
Text File  |  1992-08-31  |  22KB  |  484 lines
  1. Line View Version 1.04 Manual
  2.  
  3. Created By     Bennet Wong.
  4.  
  5.  
  6.       ---  LICENSE AGREEMENT  ---------------------------------------------
  7.           Line View  is  NOT  Public  Domain, but Shareware.  You now  have
  8.       the  NON-REGISTERED version of Line View, which means you are free to
  9.       evaluate the game for 15 days, and see if it's  something  you  might
  10.       like  to  keep.  After 15 days, you are required to either delete the
  11.       program and all files, or register the program.
  12.  
  13.           Please feel free to distribute  this  non-registered  version  so
  14.       others  will  be  able to use it also.  It must be distributed in its
  15.       complete,  unaltered  form  (i.e.,   all   manuals,   files,   etc.).
  16.       Commercial distributors of Shareware must obtain  written  permission
  17.       from the author before making this product available.  You may charge
  18.       no more than $5 to cover the cost of disk fees, etc.
  19.  
  20.           Do  not  de-compile  or  disassemble  this program.  Doing so, or
  21.       violating any other part of this license agreement, is  a  breech  of
  22.       the copyright notice.
  23.  
  24.  
  25.  
  26.  
  27.  
  28.       ---  ORDERING INFORMATION  ------------------------------------------
  29.           To register Line View, print out the form ORDER.FRM and send it
  30.       complete with U.S. funds.  For more information about ordering, see
  31.       REGISTER.DOC.
  32.  
  33.  
  34.  
  35.  
  36.  
  37.       ---  SUPPORT  ------------------------------------------------------
  38.           If you find any bugs in Line View, please write to:
  39.  
  40.                               Line View Support
  41.                               516 View St.
  42.                               Mt. View
  43.                               CA 94041
  44.  
  45.           Also include the following information:
  46.  
  47.                     Computer type (XT, 286, 386, etc.)
  48.                     DOS version
  49.                     VGA card type
  50.                     Serial communication card type
  51.                     The baud rate and the word structure
  52.                     Your phone number
  53.                     FAX number
  54.           Afterwards, you will be contacted as soon as possible.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.       ---  REGISTER AND UNREGISTER  ---------------------------------------
  61.        Line View is not a freeware. In order to protect myself and register
  62. user, I have decided to remove certain feature from the unregister version.
  63.  
  64.         - File capture and send
  65.         - Programmable macro keys
  66.         - Program reset function
  67.  
  68.        In addition a "please register" screen will pop up randomly after
  69. the program has processed more than 1,000 characters.
  70.  
  71.  
  72.  
  73.  
  74.  
  75.       ---  INTRODUCTION  --------------------------------------------------
  76.         So what is Line View. I am an engineering manager of a company that
  77. make serial device. My employee always complain to me that they
  78. cannot find a tools to debug ours product. They need a tool that can display
  79. HEX code, support H/W handshake, able to trap the I/O data, do through put
  80. test ... etc. Basically they need a tool that allow them to have total
  81. control over the serial communication port. Therefore I spend a weekend or
  82. so to develop this S/W package. Sine most people in my company enjoy this
  83. product, I decided to let it available to other user.
  84.  
  85.  LIVE VIEW ALLOW YOU TO HAVE TOTAL CONTROL OVER THE SERIAL COMMUNICATION
  86.  LINE. IN OTHER WORD, LINE VIEW IS A HOST SIMULATOR.
  87.  
  88.         Some of Line View features:
  89.  
  90.         - Support CTS or DSR handshake
  91.         - Sreial device throughput (CPS) test
  92.         - Support 3 type of XON/XOFF handshake (xmt,rcv,both)
  93.         - 4 programmable function keys, each can hold 64 bytes of data
  94.         - Support up to 115,200 baud
  95.         - Support 16550 UART's FIFO mode
  96.         - User toggleable DTR and RTS line
  97.         - CTS, DSR, XOFF status monitor
  98.         - User selectable framming error detection
  99.         - 8 bit xmt mode
  100.         - CR or CR/LF mode
  101.         - Increase data viewing area
  102.         - A much faster window interface
  103.         - An much much more ......
  104.  
  105.  
  106.  
  107.  
  108.  
  109.       ---  INSTALLATION  --------------------------------------------------
  110.         All you need to do is put the files into a directory. Line View
  111. does not require any special setup. LV will automatic detect the amount of
  112. free RAM on your machine and decided the best XMT and RCV ring buffer size.
  113.  
  114.         LV will also detect the 16550 UART chip and automatic use the chip
  115. FIFO mode. Due to a BUG in the Western Digital 16550 UART chips, LV may not
  116. function correctly. After you start the program, if you saw the "16550"
  117. sign at the bottom of your screen and LV is not working, please contact
  118. me to receive a special version. The problem does not occurs on a National
  119. Semiconductor 16550 UART chip.
  120.  
  121.         One more thing, LV was developed on a color system, and I have
  122. assume most people now use a color system. If the screen look funny
  123. on your mono system, please let me know.
  124.  
  125.       ---  STARTING UP  ---------------------------------------------------
  126.         LV should be able to run on most PC with no problem. If you are
  127. planning to use the H/W handshake, make sure your RS232 cable has the
  128. connection and you are not using a no handshake null modem.
  129.  
  130.         To start LV, you should type:
  131.  
  132.         LV <com><sp><baud><par><data><stop>
  133.  
  134. <com>   Communication port COM1 or COM2. Do not put a ':' at the end.
  135.         LV will only support COM1 or COM2. Default is COM2, I assume
  136.         most people will have a mouse hook up to COM1.
  137.  
  138. <sp>    Space. You must leave a space (20HEX) between <com> and <baud>.
  139.  
  140. <baud>  Baud rate. LV should support anything from 100 baud to 115,200 baud.
  141.         This value must be a integer, dafault is 9600.
  142.  
  143. <par>   Parity. LV support the follwing parity setting 'N' for NONE,
  144.         'O' for ODD, 'E' for EVEN. This value must be in Upper Case,
  145.         default is NONE.
  146.  
  147. <data>  Data bits. LV support either 8 or 7 data bits. Default is 8.
  148.  
  149. <stop>  Stop bits. LV support either 1 or 2 stop bits. Default is 1.
  150.  
  151.         Example:
  152.  
  153.         LV COM1 38400N81
  154.         This will set LV to Communication port 1, 38400 baud rate, No parity,
  155.         8 data bits and 1 stop bit.
  156.  
  157.         After the opening credit, LV is ready to be used. The default setting
  158. for LV is:
  159.         - COM2, 9600 baud, 8 data bits, 1 stop bit, no parity
  160.         - 7 bit xmt mode, both way XON/XOFF handshake, H/W handshake off
  161.         - DTR high, RTS high
  162.         - framming error character ignore
  163.         - VT220-8 KB emulation, line feed mode off
  164.         - Hex display mode on, and 16550 FIFO mode on. (if 16550 is in the PC)
  165.  
  166.  
  167.  
  168.  
  169.  
  170.       ---  GENERAL OPERATION  ---------------------------------------------
  171.         After you start LV two windows will appear on the screen. The top
  172. windows (TW) will echo the key you have press on the IBM keyboard. Please
  173. notice that you can still use the DOS ALT-keypad command inside LV. For
  174. people who don't know what that is, DOS allow you to access anyone of the
  175. 255 characters by holding down the <Alt> key and key in the character
  176. decimal value on the keypad. Please be careful while using this command,
  177. specially if you are using S/W handshake.
  178.  
  179.         The lower window (RW) is use to display character being received by
  180. the PC. You can control the display format for both windows, please read
  181. to the COMMAND section for more information. Please notice that if you
  182. selected XON/XOFF handshake, under certain setup the XON/XOFF signal
  183. may not be displayed on the screen.
  184.  
  185.         Line View is very easy to use, its has a very powerful command set
  186. which make it a very powerful development tool.
  187.  
  188.  
  189.  
  190.  
  191.  
  192.       ---  COMMAND SET  ---------------------------------------------------
  193.         Line View power is come from its rich command set. Here is a list
  194. off its command:
  195.  
  196.         F1              HELP
  197.         F2              Toggle handshake monitor
  198.         F3              Throughput test (CPS Test)
  199.         F5 - F8         User programmable macro keys
  200.         F9              Test pattern
  201.         F10             DOS Shell
  202.         Arrow Keys      Pre programed macro keys
  203.         Page Up         Send file
  204.         Page Down       Trap file
  205.  
  206.         Alt 0           Send NULL character
  207.         Alt 1           Toggle DTR signal
  208.         Alt 2           Toggle RTS signal
  209.         Alt 8           Toggle 8 bit xmt mode
  210.         Alt 9           Toggle error detection
  211.         Alt c           Toggle between COM1, COM2
  212.         Alt d           Change display format
  213.         Alt e           Change pre programed macro keys emulation
  214.         Alt f           Send down all 255 characters
  215.         Alt h           Change H/W handshake
  216.         Alt l           Toggle Line Feed mode
  217.         Alt p           Change port setting
  218.         Alt r           Reset program
  219.         Alt s           Change S/W handshake
  220.         Alt x           Exit
  221.  
  222.  F1 (HELP)
  223.         This command cause LV to display a help screen. All screen data
  224.         will restore upon exit.
  225.  
  226.  F2 (Toggle handshake monitor)
  227.         User has the choice to monitor XON/XOFF handshake by using the F2 key.
  228.         A "BLUE X" will be displayed on the lower status line to indicate
  229.         monitor mode setting. When LV is in this mode all XON/XOFF signal
  230.         received from the communication port will be displayed. Notice that
  231.         XOFF monitor mode will not work while LV is:
  232.         a. programming, sending or clearing macro keys.
  233.         b. trapping or sending file.
  234.  
  235.  F3 (Throughput test)
  236.         THE DEVICE YOU PLAN TO TEST MUST SUPPORT ACK COMMAND. To verify this,
  237.         before you test the device, send down a 05 HEX (Ctrl- E). If the
  238.         device respond a 06 Hex (Ctrl - F) then the device support ACK.
  239.         Otherwise do not use this test, it will cause the PC to hang up.
  240.  
  241.         This is the programmable CPS test. After you make the selection, LV will
  242.         ask you to input the test data. Test data can be any character between
  243.         0x00 to 0xFF except 0x08,0x11,0x13 and 0x7F. Test data string can be
  244.         up to 64 characters long. You will need to press the <End> button
  245.         to end the programming. Hitting the left arrow key will allow you
  246.         to correct misstake. All ctrl-character will be displayed in RED
  247.         attribute. Remember your device must support the ACK command.
  248.         LV will start a internal timmer and start sending down the test string
  249.         as soon as you press the <End> key. You can use the keyboard to stop
  250.         the test. After the user stop the test, LV will calculate the CPS
  251.         rate base on the characters it send and the value in the internal
  252.         timmer. Please notice that, LV will not start to calculate the result
  253.         until both the PC and the test device buffer is empty. Therefore it
  254.         may take a while before LV display the result.
  255.  
  256.  F5 - F8 (Programmable macro keys)
  257.         Please read to the macro key section for more information.
  258.  
  259.  F9 (Test pattern)
  260.         This option will cause LV to generate a test string of character and
  261.         send it down to the port. LV will also attach a CR/LF at the end of
  262.         the string. This pattern will continue until the user press a key on
  263.         the PC KB. LV will not return to normal operation (even the user stop
  264.         it by press the PC KB) until the output buffer in the PC is empty.
  265.  
  266.  F10 (Shell to DOS)
  267.         This command will make LV to start a new DOS shell. All of the screen
  268.         data is saved in RAM and will restore upon exit of DOS shell. If there
  269.         are not enough RAM in the system, this command may not go through.
  270.  
  271.  Arrow Key (Pre programed macro key)
  272.         Please read to the macro key section for more information.
  273.  
  274.  Page UP (Send File)
  275.         This command is use to send out an ASCII file. It will stop
  276.         automatically when it reach the EOF and the xmt buffer in the PC is
  277.         empty. Hitting the ESC key on the PC KB will stop the process. If the
  278.         xmt LF mode is enable, a LF will be attached to every CR send by LV.
  279.         You also have the option to select xmt limit rate (1 CPS, 10 CPS,
  280.         or full speed).
  281.         Please noticed that while in LV is xmting the file, the file's data
  282.         will be displayed on the lower window. Do not confuse this with
  283.         incoming data.
  284.  
  285.   Page Down (Trap File)
  286.         LV will first ask for two files name. The first one is where LV store
  287.         the raw ASCII data. The second file is where LV store the printable
  288.         HEX data. Each line in the printable HEX data file will have the
  289.         following format:
  290.  
  291. 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00       abcdefghijklmnop
  292. |---------------------------------------------|       |--------------|
  293.                      |                                       |
  294.            16 bytes in HEX format                            |
  295.                                                              |
  296.                                                 The same 16 bytes in printable
  297.                                                 ASCII format. If character is
  298.                                                 not printabel a '.' will be
  299.                                                 displayed.
  300.  
  301.         A copy of the character will also be displayed on the screen. You can
  302.         still send data to the port through the PC keyboard.
  303.         You can turn off this function by pressing the PG DWN key again.
  304.         If XON/XOFF handshake is enable, 0x13 and 0x11 will not be capture.
  305.  
  306.  Alt 0 (Send NULL character)
  307.         Normally LV will only process NULL (00 HEX) but will not send it out.
  308.         You can use this command to force LV to do so. Please notice that
  309.         you cannot program NULL character into any programmable macro keys.
  310.  
  311.  Alt 1  (Toggle DTR signal)  default: High
  312.         Cause LV to change the state of the DTR signal.
  313.  
  314.  Alt 2  (Toggle RTS signal)  default: High
  315.         Cause LV to change the state of the RTS signal.
  316.  
  317.  Alt 8  (Toggle 8 bit xmt mode)  default: Off
  318.         If enable, the high bit of every character send out by LV will be
  319.         set to high. For example <p> will become F0 HEX. This mode will
  320.         affect the ESC key and File Xmt, but will not affect macro keys.
  321.  
  322.  Alt 9 (Error detection setting)  default: Off
  323.         If enable LV will put the error character into the buffer. By putting
  324.         the error character into the buffer does not implied that the
  325.         character will be processed.
  326.  
  327.  Alt c (Toggle between COM1 and COM2)
  328.         This command allow you to select between the ports. Please notice
  329.         that only the port has change, the baud rate and word structure
  330.         is not affected by this command.
  331.  
  332.  Alt d (Change display format)  default: HEX
  333.         There are three different selections for this mode setting. This
  334.         command will only affect incoming character, character that has
  335.         already been displayed will not be affected.
  336.                   HEX: All incoming character that is between 0x00 - 0x1F,
  337.                        0x7F - 0xFF will be displayed in a HEX code format. For
  338.                        example a CR will be displayed as a "<0D>".
  339.                 ASCII: All incoming character that is between 0x00 - 0x1F
  340.                        will be displayed in their ASCII name. For example a CR
  341.                        will be displayed as a "<CR>". any character that is
  342.                        above 0x7f or don't have a standard ASCII name will be
  343.                        displayed as "<***>".
  344.               MONITOR: All incoming character will be displayed in HEX
  345.                        format.
  346.  
  347.  
  348.  Alt e (Change programed macro keys emulation)
  349.         Read to macro key section for more information.
  350.  
  351.  Alt f (Send down all 255 characters)
  352.         This cause LV to send down all 255 character to the device in a
  353.         standard ASCII table structure.
  354.  
  355.  Alt h (Change H/W handshake)  default: Off
  356.         This command is use to set the H/W handshake type on LV. You will
  357.         have 3 different choice. Each time you use this command will cause
  358.         LV to disable S/W handshake.
  359.                 NONE: No H/W handshake.
  360.                  DSR: DSR handshake.
  361.                  CTS: CTS handshake.
  362.  
  363.  Alt l (Toggle Line Feed mode)  default: Off
  364.         When this mode in enable, a LF will be attached to every CR send
  365.         by LV. This mode does not affect: Test pattern, CPS test and macro
  366.         keys.
  367.  
  368.  Alt p (Change port setting)  default: 9600,N,8,1
  369.         Change the baud rate and word structure of the current port.
  370.  
  371.  Alt r (Reset program)
  372.         Cause the program to reset to default setting and clear the screen.
  373.  
  374.  Alt s (Change S/W handshake) default: BOTH
  375.         This command is use to set the S/W handshake type on LV. You will
  376.         have 4 different choice. Each time you issue this command will cause
  377.         LV to reset (disable) the H/W handshake.
  378.                  NONE: No S/W handshake.
  379.                  BOTH: Both xmt and rcv handshake.
  380.                  XMT: Xmt handshake only.
  381.                  RCV: RCV handshake only.
  382.  
  383.  Alt x (Exit)
  384.         Exit Line View.
  385.  
  386.  
  387.  
  388.  
  389.  
  390.       ---  MACRO KEYS  ----------------------------------------------------
  391.  
  392.         There are 4 programmable macro keys in LV (F5 - F8), each can hold up
  393. to 64 character. Character can be from 0x01 to 0xFF. All characters that are
  394. between 0x01 to 0x1F will be displayed with the 6th bit set to high and in RED
  395. attribute. Example a 0x0D (CR) will be displayed as a RED "M". Character
  396. between 0x80 to 0xFF will be displayed using the IBM high character
  397. set.
  398.  
  399.         PROGRAMMING: You can program any one of the four keys by pressing
  400.         the <ALT> and the key at the same time. A program window will be
  401.         displayed at the middle of the screen. You can key in up to 64
  402.         characters, once you reach the limit LV will generate a BEEP and
  403.         will not allow you to go on any further. Pressing the <End> key will
  404.         stop the programming and exit you back to normal mode. <Left arrow>
  405.         key will allow you to correct mistake. After you exit back to the
  406.         normal mode a programed indicator will be displayed at the screen.
  407.  
  408.         CLEARING: You can clear any one of the four keys by pressing the
  409.         <CTRL> and that key at the same time. After you clear a macro key,
  410.         its indicator will be turn off.
  411.  
  412.         VIEWING: To view a macro key contain, you need to press the <SHIFT>
  413.         and that key at the same time.
  414.  
  415.         In Version 1.0, only the arrows keys are pre programed. They are being
  416. programed with the cursor movement command corresponding to the keyboard
  417. emulation. For example the <UP ARROW> in a VT200-7 emulation will send out
  418. the string "ESC[A". You can change the code the arrow keys send out by
  419. changing the KB emulation (Alt e).
  420.  
  421.  
  422.  
  423.  
  424.  
  425.       ---  STATUS DISPLAY  ------------------------------------------------
  426.         The bottom status 1 display include:
  427. <com> <params> <hs><l><dsp><xmt><err><DSR> <CTS> ... <16550> ... <DTR>  <RTS>
  428.  
  429. <com>: Communication port currently active.
  430. <params>: Word structure and baud for the active port.
  431. <hs>: Type of handshake.
  432.         BO : Both way XON/XOFF          XM : xmt XON/XOFF
  433.         RC : Receive XON/XOFF           DR : DTR
  434.         CS : CTS
  435. <l>: Line Feed Mode.
  436. <dsp>: Display Mode.
  437.          H : HEX mode                   A : ASCII Display
  438.          M : Monitor
  439. <xmt>: 8 bits xmt mode.
  440. <err>: Error detection.
  441. <DSR>: PC port DSR line state. (ON: high, OFF: Low)
  442. <CTS>: PC port CTS line state
  443. <16550>: This will show up if the PC use 16550 UART
  444. <DTR>: PC port DTR line state.
  445. <RTS>: PC port RTS line state.
  446.  
  447.  
  448.         Status 2 display is displayed at the bottom of the screen.
  449. <Keyboard> ....... <F5> <F6> <F7> <F8>
  450.  
  451. <Keyboard>: Type of keyboard emulation.
  452. <F5> ... <F8>: Will be turn on if user program the macro key.
  453.  
  454.         There is also a clock and a total income character counter on the
  455.         screen.
  456.  
  457.       ---  FINAL WORD  ----------------------------------------------------
  458.         English is not my mother language, and I expect a lot of language
  459. error in this manual. I will try by best to correct them. As for the
  460. program itself should be very dependable if you like the S/W please register.
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                           DISCLAIMER/WARRANTY/LICENSE
  467.                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  468.  
  469.             THIS  PROGRAM,  DOCUMENTATION,  AND  GRAPHICS  FILES   ARE
  470.             COPYRIGHT  1992  BY THE AUTHOR . YOU ARE HEREBY GRANTED
  471.             PERMISSION  TO  FREELY  DISTRIBUTE  AND  USE  THIS PROGRAM
  472.             FOR  PERSONAL USE. YOU MAY UPLOAD THIS PROGRAM TO AN
  473.             ELECTRONIC BULLETIN BOARD SYSTEM  OR  AN  INTERNET  FTP
  474.             SITE. THE REGISTERED VERSION ON THE OTHER HAND, MAY NOT BE
  475.             DISTRIBUTED.
  476.  
  477.             THERE IS NO WARRANTY OF ANY KIND; THIS SOFTWARE PACKAGE IS
  478.             PROVIDED  ON AN "AS-IS" BASIS. THE AUTHOR OF THIS SOFTWARE SHALL
  479.             NOT  BE  LIABLE  FOR  ANY DAMAGES  WHATSOEVER   THAT   MAY
  480.             RESULT,   DIRECTLY  OR INDIRECTLY, FROM   THE   USE   OF   THIS
  481.             SOFTWARE   OR   DOCUMENTATION. BY  OWNING A COPY OF AND OR USING
  482.             THIS SOFTWARE, YOU AGREE TO ALL THE ABOVE TERMS.
  483.  
  484.